docs: Update README for translated pathnames by caweidmann · Pull Request #6888 · TanStack/router

caweidmann · 2026-03-11T10:15:59Z

Summary by CodeRabbit

Documentation
- Added comprehensive integration guide for Paraglide with TanStack Start, including configuration examples, type-safe routing setup patterns, and detailed implementation instructions. The guide provides practical code examples, configuration workflow details, and step-by-step setup documentation to help developers implement application internationalization with proper pathname management.

coderabbitai · 2026-03-11T10:16:17Z

📝 Walkthrough

Walkthrough

Documentation additions for integrating Paraglide with TanStack Start, including code examples for declaring translated pathnames in i18n/lib.ts and configuring the Vite plugin with urlPatterns in vite.config.ts.

Changes

Cohort / File(s)	Summary
Documentation `examples/react/start-i18n-paraglide/README.md`	Adds i18n helper and Vite plugin configuration code examples demonstrating translated pathname declaration and urlPatterns integration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Hopping through docs, we plant a seed,
i18n pathways for all to read,
Paraglide takes flight with Vite's embrace,
Configuration examples light the way with grace! 🌍✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: Update README for translated pathnames' accurately describes the main change: adding documentation about translated pathnames to the README file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-03-11T10:19:03Z

Bundle Size Benchmarks

Commit: 870cf2806695
Measured at: 2026-03-11T10:18:16.387Z
Baseline source: history:870cf2806695
Dashboard: bundle-size history

Scenario	Current (gzip)	Delta vs baseline	Raw	Brotli	Trend
`react-router.minimal`	87.09 KiB	0 B (0.00%)	274.11 KiB	75.68 KiB	▁▁▁▁▆▆▇▇███
`react-router.full`	90.08 KiB	0 B (0.00%)	284.36 KiB	78.32 KiB	▁▁▁▁▅▅▆▆███
`solid-router.minimal`	36.42 KiB	0 B (0.00%)	109.29 KiB	32.74 KiB	▁▁▁▁▅▆▇▇███
`solid-router.full`	40.75 KiB	0 B (0.00%)	122.27 KiB	36.58 KiB	▁▁▁▁▄▅▇▇███
`vue-router.minimal`	52.29 KiB	0 B (0.00%)	149.34 KiB	47.01 KiB	▁▁▁▁▅▅▇▇███
`vue-router.full`	57.08 KiB	0 B (0.00%)	164.85 KiB	51.27 KiB	▁▁▁▁▅▅▇▇███
`react-start.minimal`	99.66 KiB	0 B (0.00%)	313.26 KiB	86.22 KiB	▁▁▁▁▅▅▇▇███
`react-start.full`	102.97 KiB	0 B (0.00%)	322.99 KiB	89.07 KiB	▁▁▁▁▅▅▆▆███
`solid-start.minimal`	48.75 KiB	0 B (0.00%)	146.89 KiB	43.14 KiB	▁▁▁▁▅▅▇▇███
`solid-start.full`	54.21 KiB	0 B (0.00%)	162.75 KiB	47.88 KiB	▁▁▁▁▅▅▇▇███

Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better.

coderabbitai

🧹 Nitpick comments (1)

examples/react/start-i18n-paraglide/README.md (1)
192-206: Helpful example showing the import pattern.

The code block effectively demonstrates how to import and use the translatedPathnames in the Vite configuration. The import path is consistent with the file structure established in the previous section.

Minor enhancement suggestion: The transition text at line 192 could be more explicit about updating vite.config.ts:
-And import into the Paraglide Vite plugin.
+Update your `vite.config.ts` to import and use the `translatedPathnames`:
This makes it immediately clear where to add the code.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@examples/react/start-i18n-paraglide/README.md` around lines 192 - 206, Update
the transitional sentence before the code block to explicitly tell the reader to
add the import and plugin option to their Vite configuration: mention that they
should open their Vite config and import translatedPathnames, then pass it to
paraglideVitePlugin via the urlPatterns option (as shown in the code block using
translatedPathnames and paraglideVitePlugin) so it's clear where to place the
snippet.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@examples/react/start-i18n-paraglide/README.md`:
- Around line 192-206: Update the transitional sentence before the code block to
explicitly tell the reader to add the import and plugin option to their Vite
configuration: mention that they should open their Vite config and import
translatedPathnames, then pass it to paraglideVitePlugin via the urlPatterns
option (as shown in the code block using translatedPathnames and
paraglideVitePlugin) so it's clear where to place the snippet.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2be8512a-e09e-48a2-8396-8dfe0116ba6c

📥 Commits

Reviewing files that changed from the base of the PR and between 870cf28 and 0d21bfa.

📒 Files selected for processing (1)

examples/react/start-i18n-paraglide/README.md

nx-cloud · 2026-03-14T10:39:12Z

View your CI Pipeline Execution ↗ for commit 0d21bfa

Command	Status	Duration	Result
`nx affected --targets=test:eslint,test:unit,tes...`	✅ Succeeded	<1s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	4s	View ↗

☁️ Nx Cloud last updated this comment at 2026-03-14 10:39:58 UTC

pkg-pr-new · 2026-03-14T10:40:42Z

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@6888

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/@tanstack/eslint-plugin-router@6888

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@6888

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/@tanstack/nitro-v2-vite-plugin@6888

@tanstack/react-router

npm i https://pkg.pr.new/@tanstack/react-router@6888

@tanstack/react-router-devtools

npm i https://pkg.pr.new/@tanstack/react-router-devtools@6888

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/@tanstack/react-router-ssr-query@6888

@tanstack/react-start

npm i https://pkg.pr.new/@tanstack/react-start@6888

@tanstack/react-start-client

npm i https://pkg.pr.new/@tanstack/react-start-client@6888

@tanstack/react-start-server

npm i https://pkg.pr.new/@tanstack/react-start-server@6888

@tanstack/router-cli

npm i https://pkg.pr.new/@tanstack/router-cli@6888

@tanstack/router-core

npm i https://pkg.pr.new/@tanstack/router-core@6888

@tanstack/router-devtools

npm i https://pkg.pr.new/@tanstack/router-devtools@6888

@tanstack/router-devtools-core

npm i https://pkg.pr.new/@tanstack/router-devtools-core@6888

@tanstack/router-generator

npm i https://pkg.pr.new/@tanstack/router-generator@6888

@tanstack/router-plugin

npm i https://pkg.pr.new/@tanstack/router-plugin@6888

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/@tanstack/router-ssr-query-core@6888

@tanstack/router-utils

npm i https://pkg.pr.new/@tanstack/router-utils@6888

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/@tanstack/router-vite-plugin@6888

@tanstack/solid-router

npm i https://pkg.pr.new/@tanstack/solid-router@6888

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/@tanstack/solid-router-devtools@6888

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/@tanstack/solid-router-ssr-query@6888

@tanstack/solid-start

npm i https://pkg.pr.new/@tanstack/solid-start@6888

@tanstack/solid-start-client

npm i https://pkg.pr.new/@tanstack/solid-start-client@6888

@tanstack/solid-start-server

npm i https://pkg.pr.new/@tanstack/solid-start-server@6888

@tanstack/start-client-core

npm i https://pkg.pr.new/@tanstack/start-client-core@6888

@tanstack/start-fn-stubs

npm i https://pkg.pr.new/@tanstack/start-fn-stubs@6888

@tanstack/start-plugin-core

npm i https://pkg.pr.new/@tanstack/start-plugin-core@6888

@tanstack/start-server-core

npm i https://pkg.pr.new/@tanstack/start-server-core@6888

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/@tanstack/start-static-server-functions@6888

@tanstack/start-storage-context

npm i https://pkg.pr.new/@tanstack/start-storage-context@6888

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@6888

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@6888

@tanstack/vue-router

npm i https://pkg.pr.new/@tanstack/vue-router@6888

@tanstack/vue-router-devtools

npm i https://pkg.pr.new/@tanstack/vue-router-devtools@6888

@tanstack/vue-router-ssr-query

npm i https://pkg.pr.new/@tanstack/vue-router-ssr-query@6888

@tanstack/vue-start

npm i https://pkg.pr.new/@tanstack/vue-start@6888

@tanstack/vue-start-client

npm i https://pkg.pr.new/@tanstack/vue-start-client@6888

@tanstack/vue-start-server

npm i https://pkg.pr.new/@tanstack/vue-start-server@6888

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@6888

commit: 3d24304

codspeed-hq · 2026-03-14T10:57:25Z

Merging this PR will not alter performance

✅ 6 untouched benchmarks

_{Comparing caweidmann:patch-1 (0d21bfa) with main (870cf28)}

nlynzaad · 2026-03-14T11:08:22Z

Thanks for this

docs: Update README for translated pathnames

0d21bfa

coderabbitai bot reviewed Mar 11, 2026

View reviewed changes

nlynzaad merged commit bb122e0 into TanStack:main Mar 14, 2026
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: Update README for translated pathnames#6888

docs: Update README for translated pathnames#6888
nlynzaad merged 1 commit intoTanStack:mainfrom
caweidmann:patch-1

caweidmann commented Mar 11, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Mar 11, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

github-actions bot commented Mar 11, 2026

Uh oh!

coderabbitai bot left a comment

Uh oh!

nx-cloud bot commented Mar 14, 2026 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Mar 14, 2026

Uh oh!

codspeed-hq bot commented Mar 14, 2026

Uh oh!

Uh oh!

nlynzaad commented Mar 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

caweidmann commented Mar 11, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

github-actions bot commented Mar 11, 2026

Bundle Size Benchmarks

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

nx-cloud bot commented Mar 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Mar 14, 2026

Uh oh!

codspeed-hq bot commented Mar 14, 2026

Merging this PR will not alter performance

Uh oh!

Uh oh!

nlynzaad commented Mar 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

caweidmann commented Mar 11, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 11, 2026 •

edited

Loading

nx-cloud bot commented Mar 14, 2026 •

edited

Loading